Skip to content

Fix versionFlag to output to stdout #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 31, 2025
Merged

Conversation

coincashew
Copy link
Contributor

@coincashew coincashew commented Dec 20, 2024

📝 Summary

Rollsback a change which affected the versionFlag output
mev-boost --version
outputs to stdout once again.

Version output is currently outputting to stderr.

⛱ Motivation and Context

Fixes coincashew/EthPillar#47

Before


After

mev-boost v1.8.1-6-gc574ad2-dev

cli/main.go Outdated
@@ -55,7 +55,7 @@ func Main() {
func start(_ context.Context, cmd *cli.Command) error {
// Only print the version if the flag is set
if cmd.IsSet(versionFlag.Name) {
log.Infof("mev-boost %s\n", config.Version)
fmt.Printf("mev-boost %s\n", config.Version) //nolint
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably better to do the setupLogging step first, which sets it to stdout, and keep using log.Infof.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using fmt.Printf here is the right thing actually. Otherwise, the output is difficult to parse:

$ ./mev-boost --version
INFO[2025-01-31T08:45:58.966-06:00] starting mev-boost                            version=3c51355-dev
INFO[2025-01-31T08:45:58.966-06:00] mev-boost 3c51355-dev                         version=3c51355-dev

And this would break EthPillar's regex here:

MB=$(if [[ -f /etc/systemd/system/mevboost.service ]]; then printf "Mev-boost: $(mev-boost --version | sed 's/.*\s\([0-9]*\.[0-9]*\).*/\1/')"; else printf "Mev-boost: Not Installed"; fi)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the PR to do this instead:

fmt.Fprintf(cmd.Writer, "mev-boost %s\n", config.Version)

I believe this is most appropriate for CLI apps. Doesn't require //nolint either.

@jtraglia
Copy link
Collaborator

Thanks @coincashew! I'm going to merge this now.

@jtraglia jtraglia merged commit c99f1d5 into flashbots:develop Jan 31, 2025
2 checks passed
jtraglia added a commit that referenced this pull request Apr 22, 2025
* v1.8.2-dev

* fix CONTRIBUTING lint path (#683)

* Update linters and fix issues (#707)

* Update main.go (#706)

* chore: add `.env.example` (#696)

* chore(git): add *.env, !.env.example to .gitignore

* chore: .env.example

* docs: fix invalid link in the document (#690)

* Release the RISC-V binary. (#682)

Part of #681.

* Add support for Electra (#651)

* Replace go-*-client deps with electra forks

* Add processElectraPayload

* Run make fmt

* Replace Exits with WithdrawRequests

* Rename WithdrawRequest to WithdrawalRequest

* Run go mod tidy

* Use go-*-client@electra

* Upgrade go-eth2-client

* update deps

* Add t.Helper() call

* Add back nolint comment

* Replace attestantio/go-*-client deps

* Fix accidental change

* Update go-boost-utils

* Update go-eth2-client for alpha.7 support

* Fix mistake

* Update & reverse payload decoding order

* Revert decoding order & add replacements

* Update go-eth2-client

* Update go-builder-client

* Modify processElectraPayload to use a channel (#704)

* server: refactor processElectraPayload (#703)

* Update go-eth2-client to latest electra commit

* Remove nolint:canonicalheader comments

* Disable canonicalheader linter

---------

Co-authored-by: avalonche <[email protected]>
Co-authored-by: Tyler <[email protected]>

* Update golang to 1.23 (#717)

* Update linter tools (#718)

* Update dependencies (#716)

* Update go-ethereum to v1.14.13

* Update go-utils to v0.8.3

* Update uint256 to v1.3.2

* Update testify to v1.10.0

* Update urfave/cli/v3 to v3.0.0-beta1

* Update go-bitfield to v0.0.0-20240618144021-706c95b2dd15

* Bump golang.org/x/crypto from 0.23.0 to 0.31.0 (#714)

Bumps [golang.org/x/crypto](https://github.com/golang/crypto) from 0.23.0 to 0.31.0.
- [Commits](golang/crypto@v0.23.0...v0.31.0)

---
updated-dependencies:
- dependency-name: golang.org/x/crypto
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Minor cleanup (#715)

* server: refactor bidRespKey

* server: split http handling and functionality

* Fix versionFlag to output to stdout (#710)

* Fix versionFlag to output to stdout

* Write version with fmt.Fprintf(cmd.Writer, ...)

---------

Co-authored-by: Justin Traglia <[email protected]>
Co-authored-by: Justin Traglia <[email protected]>

* server: split http handling and functionality (part2) (#721)

* server: split out logger preparation (#722)

* server: make processPayload generic (#723)

* server: re-add capella types (#724)

* server: re-add capella types

* Remove unnecessary type arguments

* Add missing verifyBlockhash for electra

---------

Co-authored-by: Justin Traglia <[email protected]>

* server: re-add bellatrix support (#725)

* server: re-add bellatrix support

* Remove unnecessary type arguments

* server: refactor TestGetPayloadFork tests (#726)

* server: refactor getPayloadForks tests

* server: remove old tests

* server: add nolint directive

* server: remove duplicate tests

* server: tiny refactor

* server: tiny refactor

* server: tiny refactor

* server: refactor tests again

* Rename denebHeader & add comment

---------

Co-authored-by: Justin Traglia <[email protected]>

* Fix various nits (#728)

* Make error message better

* Use phase0.Slot type for slots

* Do a little clean up in service

* Rename "_slot" to "slot"

* Clean up getHeader function

* Do some clean up in functionality

* Split functionality.go into get_{header,payload}.go (#730)

* Use consistent capitalization for log messages (#732)

* Add fixes to SendHTTPRequest (#735)

* add missing error check

* move error check and use the same format for header comments

* Bump github.com/ethereum/go-ethereum from 1.14.13 to 1.15.0 (#737)

Bumps [github.com/ethereum/go-ethereum](https://github.com/ethereum/go-ethereum) from 1.14.13 to 1.15.0.
- [Release notes](https://github.com/ethereum/go-ethereum/releases)
- [Commits](ethereum/go-ethereum@v1.14.13...v1.15.0)

---
updated-dependencies:
- dependency-name: github.com/ethereum/go-ethereum
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Forward validator registrations without decoding (#733)

* Bump github.com/ethereum/go-ethereum from 1.15.0 to 1.15.1 (#740)

Bumps [github.com/ethereum/go-ethereum](https://github.com/ethereum/go-ethereum) from 1.15.0 to 1.15.1.
- [Release notes](https://github.com/ethereum/go-ethereum/releases)
- [Commits](ethereum/go-ethereum@v1.15.0...v1.15.1)

---
updated-dependencies:
- dependency-name: github.com/ethereum/go-ethereum
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add SSZ tests for registerValidator (#741)

* Add SSZ tests for registerValidator

* Simplify conditional

* Fix a flakey test

* Remove support for relay monitors (#739)

* Remove support for relay monitors

* Remove blocknative relay from example

* Add getHeader SSZ support (#734)

* docs: fix Rémy Roy's guide link in README.md (#744)

* docs: fix Rémy Roy's guide link in README.md

* Update README.md

Co-authored-by: Marius van der Wijden <[email protected]>

---------

Co-authored-by: Marius van der Wijden <[email protected]>

* Bump github.com/ethereum/go-ethereum from 1.15.1 to 1.15.2 (#743)

Bumps [github.com/ethereum/go-ethereum](https://github.com/ethereum/go-ethereum) from 1.15.1 to 1.15.2.
- [Release notes](https://github.com/ethereum/go-ethereum/releases)
- [Commits](ethereum/go-ethereum@v1.15.1...v1.15.2)

---
updated-dependencies:
- dependency-name: github.com/ethereum/go-ethereum
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump github.com/attestantio/go-builder-client (#745)

* Add HeaderDateMilliseconds for improved request timing tracking (#748)

- Introduce new HeaderDateMilliseconds constant in constants.go
- Add HeaderDateMilliseconds to getHeader and processPayload methods
- Mark HeaderStartTimeUnixMS as deprecated with a comment

* Update dependencies (#755)

* Upgrade to go 1.24

* Update dependencies

* Update linters & fix complaints

* Update go versions elsewhere

* Add Hoodi testnet flag (#758)

* Add hoodi flag to the CLI

* Update docs

* Add getPayload SSZ support  (#742)

* Start to add getPayload SSZ support

* Add log for failed content parsing

* Update go-builder-client

* Properly parse getPayload response content type

* s/relaysToRequestFrom/relays

* Do a single SSZ to JSON conversion if necessary

* Only use JSON if necessary

* Simplify

* Only do conversion if necessary

* Bump version to v1.9-rc3 (#759)

* Remove deprecated HeaderStartTimeUnixMS (#749)

- Remove HeaderStartTimeUnixMS constant from constants.go
- Remove HeaderStartTimeUnixMS from getHeader and processPayload methods
- Fully transition to using HeaderDateMilliseconds for request timing

Co-authored-by: Justin Traglia <[email protected]>

* Add more logging to registerValidator (#768)

* fix: JSON Content-Type for relay get payload w/o SSZ support (#769)

* Update linters (#772)

* Update linters & migrate golangci-lint config

* Fix linter errors

* Update all dependencies (#771)

* Update version to v1.9 (#775)

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Chris Hager <[email protected]>
Co-authored-by: Jonas Warlike <[email protected]>
Co-authored-by: Tyler <[email protected]>
Co-authored-by: richard <[email protected]>
Co-authored-by: Lorenzo <[email protected]>
Co-authored-by: guckool <[email protected]>
Co-authored-by: Leonardo Arias <[email protected]>
Co-authored-by: avalonche <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Marius van der Wijden <[email protected]>
Co-authored-by: coincashew <[email protected]>
Co-authored-by: Alexey Shekhirin <[email protected]>
Co-authored-by: Alexander Tesfamichael <[email protected]>
Co-authored-by: Jacob Kaufmann <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mev-boost v1.7+ no longer outputs version to stdout
3 participants